home *** CD-ROM | disk | FTP | other *** search
/ Meeting Pearls 4 / Meeting Pearls Vol. IV (1996)(GTI - Schatztruhe)[!].iso / Pearls / texmf / doc / latex / base / install.txt < prev    next >
Text File  |  1996-06-19  |  17KB  |  507 lines
  1.                    LaTeX Installation Guide
  2.  
  3.                         3 June 1996
  4.  
  5. SUMMARY
  6. =======
  7.  
  8. This file contains the installation instructions for the latest
  9. version of the LaTeX document preparation system.
  10.  
  11. The rest of this document describes:
  12.  
  13.  * How to find out about installing LaTeX for your version of TeX.
  14.  
  15.  * How the installation works.
  16.  
  17.  * What to do if anything goes wrong.
  18.  
  19. TeX experts who want to know more about how the LaTeX installation 
  20. works and how it can be customized should read texpert.txt.  
  21.  
  22.  
  23. DOCUMENTATION
  24. =============
  25.  
  26. Brief introductions to various aspects of the new LaTeX release can be
  27. found in the distributed files with names <xxx>guide.tex.  You will
  28. need to install the new version before you can typeset these files.
  29.  
  30. A full description of the new LaTeX release (and of more than 100
  31. packages that can be used with LaTeX) can be found in:
  32.  
  33.  * The LaTeX Companion, Goossens, Mittelbach and Samarin, Addison-Wesley
  34.    ISBN 0-201-54199-8.
  35.  
  36. The new release is also described in the second edition of:
  37.  
  38.  * LaTeX A Document Preparation System, Leslie Lamport, Addison-Wesley
  39.  
  40.  
  41. REQUIREMENTS
  42. ============
  43.  
  44. In addition to the LaTeX distribution files, you will also need the
  45. following:
  46.  
  47.  * a TeX system, including iniTeX (see `Your Version of TeX', below);
  48.  
  49.  * the file `hyphen.tex', or some other hyphenation files (see `Creating
  50.    the LaTeX Format', below);
  51.  
  52.  * the font files (normally .tfm files) for the Computer Modern fonts,
  53.    including some non-standard ones (see `Fonts needed', below);
  54.  
  55.  * about 6.5MB of spare disk space for use during the installation.
  56.  
  57.  
  58. YOUR VERSION OF TEX
  59. ===================
  60.  
  61. LaTeX is based upon Donald Knuth's TeX typesetting system.  This is 
  62. available for almost every make of computer, from microcomputers
  63. through workstations to large main-frames.  
  64.  
  65. Further details about how to install LaTeX for your version of TeX may
  66. be available in a file called <system>.txt.  At present the following
  67. such files exist (at least):
  68.  
  69.  * amiweb2c.txt for Amiga web2c TeX on the Amiga.
  70.  
  71.  * cstex.txt for CS-TeX on the Atari.
  72.  
  73.  * decustex.txt for TeX from DECUS on VAX/VMS.
  74.  
  75.  * directex.txt for DirectTeX on the Macintosh.
  76.  
  77.  * emtex.txt for emTeX on IBM PC compatibles.
  78.  
  79.  * lindner.txt for Lindner's TeX on the Atari.
  80.  
  81.  * microtex.txt for MicroTeX (uTeX) on IBM PC compatibles. 
  82.  
  83.  * multitex.txt for MultiTeX on the Atari.
  84.  
  85.  * oztex.txt for OzTeX on the Macintosh.
  86.  
  87.  * pastex.txt for PasTeX on the Amiga.
  88.  
  89.  * pctex.txt for PCTeX on IBM PC compatibles.
  90.  
  91.  * textures.txt for Textures on the Macintosh.
  92.  
  93.  * web2ctex.txt for web2c TeX on Unix platforms.
  94.  
  95.  * yandytex.txt for Y&YTeX on IBM PC compatibles. 
  96.  
  97. You should finish reading this file before reading the <system>.txt
  98. file for your version.  If there is no such file then this file alone is
  99. your installation guide.
  100.  
  101. If you have bought a commercial version of TeX/LaTeX and there is no
  102. file for your system then you could ask the company which sells your
  103. version of TeX to supply one.
  104.  
  105. Note to TeX implementors/suppliers:
  106. ----------------------------------
  107. If you can supply us with a <system>.txt file for your implementation
  108. we shall be very grateful and we shall add it to our distribution.
  109.  
  110.  
  111.  
  112. HOW THE INSTALLATION WORKS
  113. ==========================
  114.  
  115. The LaTeX installation is in five stages:
  116.  
  117.  * Saving any old version of LaTeX.
  118.  
  119.  * Unpacking the distribution (this may not be necessary).
  120.  
  121.  * Creating the LaTeX format.
  122.  
  123.  * Putting the files where LaTeX can read them.
  124.  
  125.  * Checking the installation.
  126.  
  127.  
  128. SAVING YOUR OLD VERSION OF LaTeX
  129. ================================
  130.  
  131. If you are currently using the old LaTeX version, 2.09, you may wish
  132. to save it before installing the new version of LaTeX.
  133.  
  134. If it exists, the <system>.txt file will describe in detail how to do
  135. this; in some of these files, the new version is referred to as
  136. LaTeX2e in order to clearly distinguish it from the old version.
  137.  
  138. The details of how to do everything in this section will depend to a
  139. very large extent on your TeX implementation.
  140.  
  141. First you should find the LaTeX format file on your system
  142. (usually called `latex.fmt' or `lplain.fmt') and rename it to
  143. `latex209.fmt'.
  144.  
  145. You should then save a copy of the current  LaTeX system files.  These
  146. may be kept in a TeX inputs directory or folder, which is usually
  147. called something like one of these:
  148.  
  149.    tex\texinput  tex/inputs  TeX-inputs
  150.  
  151. or they may be kept in a separate LaTeX inputs location, possibly a
  152. subdirectory or subfolder of the TeX inputs location, called `latex'.
  153.    
  154. There are thus two possibilities, depending on whether the LaTeX
  155. inputs have been kept separate from the other TeX inputs or not.
  156.  
  157.  * If the LaTeX inputs are separated from the other TeX inputs, then
  158.    you should make a new directory that is a copy of the whole of the
  159.    LaTeX inputs directory, and call it `latex209'.
  160.    
  161.  * If the LaTeX inputs are kept with the other TeX inputs, then you 
  162.    should create a new directory called `latex209' and then copy to it
  163.    any file ending with .sty from the LaTeX inputs directory.
  164.    
  165. It may be possible to run both the new LaTeX and LaTeX 2.09 in
  166. parallel.  To do this, you should create a `latex209' command,
  167. or menu entry, that is similar to `latex' except that:
  168.  
  169.  * The `latex209' format is used rather than `latex'.
  170.  
  171.  * The `latex209' directory is searched before the LaTeX inputs
  172.    directory.
  173.  
  174. The details of how to do this vary according to your system so you
  175. may find more information in a <system>.txt file.
  176.  
  177.  
  178. BEFORE UNPACKING THE DISTRIBUTION
  179. =================================
  180.  
  181. Latex needs a number of files to run, for example `article.cls'
  182. contains the `article' document class.  However, these files are NOT
  183. themselves the source files produced by the LaTeX3 Project Team.  We
  184. write documented sources in `docstrip archive files' which can be
  185. unpacked to produce the files that LaTeX needs. For example,
  186. classes.dtx contains the documented sources for all the LaTeX
  187. document classes, including article.cls.
  188.  
  189. The FIRST thing to do is to check whether you need to unpack these
  190. archive files, as follows.
  191.  
  192. Before reading any further, you should check to see whether the LaTeX
  193. distribution you have contains the unpacked files.  You can do this by
  194. looking to see if you have got the file latex.ltx.  If you do, then
  195. you should have all the unpacked files and so you can move on to the
  196. section entitled `Creating the LaTeX format'.
  197.  
  198. The unpacking will create and write files only into the current
  199. directory (or current folder, or default directory).  This helps to
  200. prevent it overwriting existing files or causing problems with your
  201. system files.  It is therefore sensible to carry out the installation
  202. in a directory reserved for this purpose; on a multi-user system you
  203. should ensure that you have read and write permissions for files in
  204. this directory.
  205.  
  206.  
  207. UNPACKING THE DISTRIBUTION
  208. ==========================
  209.  
  210. The archive files are unpacked by running iniTeX on the file 
  211. unpack.ins.
  212.  
  213. NOTE: On relatively slow computers, this unpacking can take a long
  214. time.  On a Macintosh SE it takes about 3 hours.  On a Macintosh
  215. Duo 230 or a 12MHz 80286 PC it takes about 30 minutes.  On a moderately
  216. busy SparcStation 10 or a fast 80486 PC it takes about 5 minutes.
  217.  
  218. NOTE: Using LaTeX with `old' DC Fonts.
  219. If you are using versions of the dc fonts older than release 1.2 (issued
  220. during 1995) then at this point you should unpack the fd files for
  221. the old dc fonts by running plain TeX or LaTeX on the file
  222. olddc.ins
  223. You need to do this even if you have obtained the `unpacked'
  224. distribution and so have not processed the unpack.ins file described
  225. above.
  226.  
  227. If this is your first installation, so you do not yet have a format,
  228. or if you are unsure of which release of the dc fonts you have, ignore
  229. this step and build the LaTeX format as described below.  The test
  230. document  ltxcheck.tex  will report any problems with the dc fonts and
  231. report whether you need to unpack olddc.ins.
  232.  
  233.  
  234. CREATING THE LATEX FORMAT
  235. =========================
  236.  
  237. To create the LaTeX format, you should run iniTeX on the file
  238. `latex.ltx'.  
  239.  
  240. A hyphenation file such as `hyphen.tex' is read by this run so it
  241. should be accessible by iniTeX.  It also needs to be able to read the
  242. `.tfm' font files for the basic fonts.  These font files and
  243. hyphenation file(s) should be part of your TeX system.
  244.  
  245. You should save the resulting format file `latex.fmt' in the TeX
  246. formats directory.  You may also have to create and/or install a
  247. program called `latex', a `LaTeX' option to your TeX implementation,
  248. or a batch file or shell script.  The details of this stage will
  249. depend on your TeX implementation; note that the name of the format
  250. file differs from that normally used in LaTeX 2.09.
  251.  
  252. Note: TeX experts may wish to customize LaTeX (for example, to allow 
  253. non-American hyphenation).  They should read cfgguide.tex to find out 
  254. how to do this.
  255.  
  256. If you are still using a very old version of TeX (pre 1990) then you
  257. must now read tex2.txt.
  258.  
  259. If you have the problem of running out of TeX memory then you may find
  260. that the experimental version of LaTeX described in autoload.txt wil
  261. help you.
  262.  
  263.  
  264. PUTTING THE FILES WHERE LaTeX CAN READ THEM
  265. ===========================================
  266.  
  267. The next step in the installation of LaTeX is to move the files needed
  268. to run the system into the correct directories (or folders).
  269. These are:
  270.  
  271.  * the directory containing the format files.
  272.  
  273.  * the LaTeX inputs directory, which contains LaTeX system files.
  274.  
  275.  * the MakeIndex inputs directory, which contains MakeIndex files.
  276.  
  277. You should move to the formats directory:
  278.  
  279.  * latex.fmt.
  280.  
  281. You should move to the LaTeX input directory the files:
  282.  
  283.  * latexbug.tex, testpage.tex, lablst.tex, idx.tex, nfssfont.tex 
  284.    small2e.tex, sample2e.tex and docstrip.tex.
  285.  
  286. and any files whose name ends with:
  287.  
  288.  * .cls,  document class files.
  289.  
  290.  * .clo,  document class options files.
  291.  
  292.  * .sty,  package files.
  293.  
  294.  * .fd,   font definition files.
  295.  
  296.  * .def,  files of definitions which may be read by LaTeX while
  297.           processing documents.
  298.  
  299.  * .cfg,  TeX expert configuration files.
  300.  
  301. You should move to the MakeIndex input directory all files
  302. whose name ends with:
  303.  
  304.  * .ist,  MakeIndex style files.
  305.  
  306. You have now installed LaTeX!
  307.  
  308.  
  309. GETTING A WORKING LaTeX
  310. =======================
  311.  
  312. You may now need to set up your system to use the new version of
  313. LaTeX; e.g. by configuring the environment, adding menu items, writing
  314. batch files or shell scripts.  Details may be found in a <system>.txt
  315. file for your system.
  316.  
  317.  
  318. CHECKING THAT THE INSTALLATION WORKED
  319. =====================================
  320.  
  321. To make sure that the installation has worked, you should run the new 
  322. LaTeX on the document `ltxcheck.tex'.  
  323.  
  324. How this is done varies according to your system; you may find the
  325. necessary detailed instructions in a <system>.txt file.
  326.  
  327. This will produce a number of messages, each of which should be `OK'.
  328. If any of them are `BAD', then read the `PROBLEMS' section below.
  329.  
  330. If all the messages are `OK' then you are finished!
  331.  
  332. Fonts needed
  333. ------------
  334.  
  335. One thing that is checked by running ltxcheck.tex is the existence of
  336. certain fonts on your system.  
  337.  
  338. The new LaTeX format assumes that you have on your system more font
  339. files from the Computer Modern families than did previous versions.
  340.  
  341. It is not essential to get all these fonts immediately but, if you do
  342. not have the .tfm files for some of them then you will get several
  343. error messages when you try to typeset any of the documentation files,
  344. such as `usrguide.tex'.
  345.  
  346. Here are some examples:
  347.  
  348.   ! Font OML/cmm/b/it/8=cmmib8 at 8.0pt not loadable:
  349.                                         Metric (TFM) file not found
  350.  
  351.   ! Font OMS/cmsy/b/n/8=cmbsy8 at 8.0pt not loadable:
  352.                                         Metric (TFM) file not found
  353.  
  354. You can, in fact, ignore all these messages (however awful they may
  355. sound) as far as typesetting the file is concerned: the results,
  356. whilst not perfect, will be little different to what was intended.
  357.  
  358. However, you should install these fonts as soon as possible (they are
  359. in the sub-directory `fonts/tfm' of the LaTeX directory on CTAN).  
  360. They are:
  361.  
  362.    cmmib5   cmmib6   cmmib7   cmmib8  cmmib9
  363.    cmbsy5   cmbsy6   cmbsy7   cmbsy8  cmbsy9
  364.  
  365.    
  366. PROBLEMS
  367. ========
  368.  
  369. On most systems the installation should proceed smoothly.  However, you
  370. may get some errors.
  371.  
  372.  
  373. `texsys.cfg':  While running iniTeX on latex.ltx you may get an error
  374.    message that reports a problem with texsys.cfg.  
  375.  
  376.    If this happens then you have obtained (or produced) a texsys.cfg
  377.    file that is not suitable for your system.  
  378.    
  379.    First, if it exists read the <system>.txt file.  This may tell you
  380.    how to customize the file texsys.cfg.
  381.    
  382.    If the <system>.txt file does not mention texsys.cfg then you should 
  383.    not need a texsys.cfg file.  Try deleting texsys.cfg and building the
  384.    LaTeX format again.
  385.    
  386.    If you still get errors, try using LaTeX to typeset ltdirchk.dtx and 
  387.    then read this document.
  388.  
  389.  The details of how to do this vary according to your system so you
  390. may find more details in a <system>.txt file.
  391.  
  392.  
  393. `File missing': Some of the files from the LaTeX distribution are
  394.    missing.  There are a number of possible reasons for this:
  395.  
  396.    * The files really are missing.
  397.      You should get the missing files from the same place you got the
  398.      rest of the distribution.  If you cannot do this then you should
  399.      complain to whoever gave you this distribution.
  400.  
  401.    * The files are present, but in the wrong directory.
  402.      You should move the files to a directory that iniTeX can read.
  403.  
  404.    * The files are present, and in the right directory.
  405.      Your iniTeX may have been set up incorrectly.  You may be able to
  406.      correct this, depending on your TeX implementation.  See the
  407.      documentation of your TeX implementation for more details.
  408.  
  409.  
  410. `Font missing': Some of the fonts (.tfm files) required by LaTeX are
  411.    missing.  As above, either you have not got the required files, or
  412.    iniTeX is not able to find them.  So you may need to move them or to
  413.    configure iniTeX to look in the correct places.  See the
  414.    documentation of your TeX implementation for more details.
  415.  
  416.  
  417. `Out of memory': On TeX implementations with small memory, you may
  418.    exhaust iniTeX's memory whilst installing LaTeX.
  419.  
  420.    You may be able to correct this:
  421.  
  422.    * Some TeX implementations allow the amount of memory allocated
  423.      to TeX to be increased.  See the documentation of your TeX
  424.      implementation for more details.
  425.  
  426.    * Some iniTeX implementations allow more memory than others; so
  427.      you may be able to run iniTeX on a larger machine and then move
  428.      the files across to the smaller machine.
  429.  
  430.    * If the error happens during the unpacking of the distribution
  431.      (i.e. when you run iniTeX on unpack.ins) then try running this
  432.      file with normal TeX, for example plain TeX or an old version
  433.      of LaTeX.
  434.  
  435.  
  436. If you have any problems installing LaTeX, you should:
  437.  
  438.  * read the <system>.txt file, if one exists;
  439.  
  440.  * if this does not help, ask your local TeX guru;
  441.  
  442.  * if this fails, try asking a local TeX mailing list;
  443.  
  444.  * if this fails, run iniTeX on the file latexbug.tex, fill in the
  445.    resulting bug report form, and send it to the address given in that
  446.    file.
  447.  
  448.  
  449. CLEARING UP
  450. ===========
  451.  
  452. You may now be wondering what to do with all the remaining files
  453. that are not needed to run LaTeX.  This is, of course, a matter of
  454. personal taste and availability of disk space but here is some
  455. guidance.
  456.  
  457.  * The files with extension .dtx, together with source2e.tex,
  458.    can be used to typeset the documented source code (see texpert.txt
  459.    for further information).
  460.  
  461.  * The files with extension .fdd contain the documented sources for
  462.    the font definition files. 
  463.  
  464.  * The files ltnews<xx>.tex and ltnews<xx>.ps both contain the latest 
  465.    LaTeX newsletter.
  466.  
  467.  * The file ltx3info.tex contains information about the LaTeX3 project
  468.    and how you can support it.
  469.  
  470.  * The files with extension .txt contain information about (amongst
  471.    other things) copyright, installation, patches and bug-reports; and
  472.    those with extension .err contain errata lists for various
  473.    publications: see 00readme.txt for further details. 
  474.  
  475.  * The files with names of the form <xxx>guide.tex contain reference 
  476.    information covering only those features new to this version of
  477.    LaTeX: they are not intended to be either a user guide or a
  478.    complete reference for the system.   
  479.  
  480.  * The files with extension .ltx, together with ltxcheck.tex, are
  481.    used to create and test the format; therefore you should keep these
  482.    if you expect to remake the format before getting the next full
  483.    distribution.
  484.  
  485.  * The files with extension .ins are used to unpack the code from the
  486.    .dtx and .fdd files.
  487.  
  488.  * We recommend that you keep, in the formats directory, the
  489.    transcript file that was produced whilst creating the format; 
  490.    this file is called latex.log or latex.lis.
  491.    
  492.   
  493. FINALLY
  494. =======
  495.  
  496. Once you have installed LaTeX for your TeX implementation, you might
  497. like to write a <system>.txt file explaining how you did it.  If you
  498. want to do this, you should edit the file template.txt.
  499.  
  500. If you would like your <system>.txt file to be included with the LaTeX
  501. distribution, please mail it to the project at the address given in
  502. the file bugs.txt and latexbug.tex.
  503.  
  504.  
  505. --- Copyright 1994, 1995, 1996
  506.     The LaTeX3 Project.  All rights reserved ---
  507.